Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: prevent parent view scroll when press space bar and arrow #56435

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

fix: prevent parent view scroll when press space bar and arrow #56435

wants to merge 14 commits into from
+59 −8

Conversation

linhvovan29546
Copy link
Contributor

@linhvovan29546 linhvovan29546 commented Feb 6, 2025 •
edited
Loading

Explanation of Change

Fixed Issues

$ #55832
PROPOSAL: #55832 (comment)

Tests

Precond: User has a long Workspace list

  1. Access staging.new.expensify.com
  2. Sign into a valid account
  3. Go to Settings > Workspace (WS) > Tap on 3 dot menu on a WS
  4. With the popup open, tap on "Space Bar" on keyboard
  5. Verify that the Workspace list does not scroll down
  • Verify that no errors appear in the JS console

Precond: User has a long list

  1. Access staging.new.expensify.com
  2. Sign into a valid account
  3. Go to Settings > Workspace (WS) > Categories > Tap on category item
  4. With the RHN open, tap on "Space Bar" on keyboard
  5. Verify that the Categories list does not scroll down
    We can apply this test to other lists as well

Offline tests

Same Test above

QA Steps

Same Test above

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

This change only apply for web and desktop

Android: mWeb Chrome
Screen.Recording.2025-02-10.at.8.52.20.PM.mov
iOS: Native

This change only apply for web and desktop

iOS: mWeb Safari
Screen.Recording.2025-02-10.at.7.14.19.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-02-06.at.7.41.49.AM.mov
Screen.Recording.2025-02-06.at.7.44.16.AM.mov
Screen.Recording.2025-02-06.at.7.44.51.AM.mov
MacOS: Desktop
Screen.Recording.2025-02-06.at.7.48.23.AM.mov

@linhvovan29546 linhvovan29546 changed the title [WIP]fix: prevent parent view scroll when press space bar and arrow fix: prevent parent view scroll when press space bar and arrow Feb 6, 2025
@linhvovan29546 linhvovan29546 marked this pull request as ready for review February 6, 2025 00:49
@linhvovan29546 linhvovan29546 requested a review from a team as a code owner February 6, 2025 00:49
@melvin-bot melvin-bot bot requested a review from DylanDylann February 6, 2025 00:49
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Feb 6, 2025

@DylanDylann Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@melvin-bot melvin-bot bot removed the request for review from a team February 6, 2025 00:49
DylanDylann
DylanDylann reviewed Feb 10, 2025
View reviewed changes
src/CONST.ts Outdated Show resolved Hide resolved
src/components/PopoverMenu.tsx Outdated Show resolved Hide resolved
src/libs/KeyboardShortcut/index.ts Outdated Show resolved Hide resolved
src/hooks/useScrollEnabled/index.ts Outdated Show resolved Hide resolved
src/hooks/useScrollEnabled/index.web.ts Outdated Show resolved Hide resolved
@linhvovan29546
Copy link
Contributor Author

I've updated and replied to the review change.

DylanDylann
DylanDylann reviewed Feb 11, 2025
View reviewed changes
src/hooks/useScrollEnabled/index.ts Outdated Show resolved Hide resolved
src/components/PopoverMenu.tsx Outdated Show resolved Hide resolved
@DylanDylann
Copy link
Contributor

@linhvovan29546 Could you help to point out a specific case that has shouldUseScrollView is true? I think it will be weird when there are 2 scrolling in the same time. Thus, to make it simpler, should we call e.preventDefault only when shouldUseScrollView is false?

As my checking, we only use shouldUseScrollView as true in 3 places: SearchTypeMenuNarrow, AccountSwitcher, VideoPopoverMenu

@linhvovan29546 Could you check 3 places to see whether we can always prevent scrolling when clicking the space button?

@DylanDylann
Copy link
Contributor

If yes, we can remove scrollableElement.scrollBy function in here

@linhvovan29546
Copy link
Contributor Author

linhvovan29546 commented Feb 13, 2025 •
edited
Loading

If yes, we can remove scrollableElement.scrollBy function in here

FYI, after merging the main branch, I noticed that the navigation has significantly changed and was broken by previous code. I am rechecking it

@linhvovan29546
Copy link
Contributor Author

@linhvovan29546 Could you help to point out a specific case that has shouldUseScrollView is true? I think it will be weird when there are 2 scrolling in the same time. Thus, to make it simpler, should we call e.preventDefault only when shouldUseScrollView is false?

@DylanDylann My bad, after checking, I think we can call e.preventDefault only when shouldUseScrollView is false.

@linhvovan29546
Copy link
Contributor Author

linhvovan29546 commented Feb 14, 2025 •
edited
Loading

I've updated it. The change in the ScrollView component is riskier than I thought because scrollEnabled is based on useIsFocused, and in some cases, useIsFocused may return false despite still being focused. I think we can move it outside ScrollView and apply it only to specific places where we see the issue, or apply it only when we need to prevent scrolling using a new flag. Wdyt?

@DylanDylann
Copy link
Contributor

DylanDylann commented Feb 14, 2025 •
edited
Loading

First, could you explain again why do we need to add scrollEnabled

@DylanDylann
Copy link
Contributor

I think this change is enough

Screenshot 2025-02-14 at 14 33 04

Or please correct me if I miss anything

@linhvovan29546
Copy link
Contributor Author

Yes, the change in the SectionList is enough! But we have a similar issue with ScrollView as well, so I added scrollEnabled to resolve it.

Screen.Recording.2025-02-14.at.2.44.40.PM.mov

@DylanDylann
Copy link
Contributor

@linhvovan29546 We can use scrollEnabled={isFocused}, right?

@DylanDylann
Copy link
Contributor

and in some cases, useIsFocused may return false despite still being focused

Could you detail this point?

@linhvovan29546
Copy link
Contributor Author

@linhvovan29546 We can use scrollEnabled={isFocused}, right?

Yes

@linhvovan29546
Copy link
Contributor Author

and in some cases, useIsFocused may return false despite still being focused

Could you detail this point?

You can add useIsFocused here and check the log.

Screenshot 2025-02-14 at 3 34 08 PM

@DylanDylann
Copy link
Contributor

@linhvovan29546 Why do you log on InitialSettingsPage?

We need to use scrollEnabled={isFocused} in ProfilePage

Screen.Recording.2025-02-14.at.16.01.35.mov

@linhvovan29546
Copy link
Contributor Author

linhvovan29546 commented Feb 14, 2025 •
edited
Loading

@linhvovan29546 Why do you log on InitialSettingsPage?

I answered the question, and in some cases, useIsFocused may return false despite still being focused. So, based on the above, do we only need to add it to the profile page?

@DylanDylann
Copy link
Contributor

For me, InitialSettingsPage isn't scrolled down when entering space

@linhvovan29546
Copy link
Contributor Author

For me, InitialSettingsPage isn't scrolled down when entering space

Thanks, I'll update

@DylanDylann
Copy link
Contributor

@linhvovan29546 Please review all your changes again and ping me when everything is ready

@linhvovan29546
Copy link
Contributor Author

@DylanDylann This is ready. Thank you for your review! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DylanDylann DylanDylann DylanDylann left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@linhvovan29546 @DylanDylann